Returns server metrics

{ readServersMetrics }

Returns server metrics.

Method

/API3/notification/readServersMetrics

  • API Section: /API3/notification
  • API Version: 3.0
  • From Release: 2025.00
  • Usage: REST API and Client SDK libraries. REST APIs via POST actions only.
  • Usage by:
    • Enterprise Admin
    • Output Response

    Successful Result Code

    200

    Response List Type

    ServerMetrics[]

    Description of Response Type

    Result object with information about each server in the system. Note that the response is returned as a list of items of this object type.

    Notes

    Reads CPU and memory usage for each server in the system. will also return active requests count size for relevant servers.

    Code Snippets

    Use the Authentication API methods to generate an access 'key' or 'token' for use in code as shown below.

    TypeScript
    Curl
    Java
    C#
    Python
    PHP
    curl -X POST \
-H "paToken: [[apiKey]]" \
 -H "Accept: application/json,application/json;charset=utf-8,text/plain,text/plain;charset=utf-8" \
 "http://Your.Server.URL/API3/notification/readServersMetrics"

    import com.pyramidanalytics.*;
import com.pyramidanalytics.auth.*;
import com.pyramidanalytics.model.*;
import com.pyramidanalytics.api.NotificationServiceApi;

import java.util.*;
import java.time.*;

public class NotificationServiceApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://Your.Server.URL/");
        
        // Configure API key authorization: paToken
        ApiKeyAuth paToken = (ApiKeyAuth) defaultClient.getAuthentication("paToken");
        paToken.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //paToken.setApiKeyPrefix("Token");

        // Create an instance of the API class
        NotificationServiceApi apiInstance = new NotificationServiceApi();

        try {
            // "array[ServerMetrics]" is only psaudo-code to symbolize list of type and not the actual usage 
            array[ServerMetrics] result = apiInstance.readServersMetrics();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NotificationServiceApi#readServersMetrics");
            e.printStackTrace();
        }
    }
}

    import * as PyramidAnalyticsWebApi from "com.pyramidanalytics";

// Create an instance of the API class
const api = new PyramidAnalyticsWebApi.NotificationServiceApi("http://Your.Server.URL")
api.readServersMetrics().then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});


    using System;
using System.Diagnostics;
using PyramidAnalytics.Sdk.Api;
using PyramidAnalytics.Sdk.Client;
using PyramidAnalytics.Sdk.Model;

public class readServersMetricsExample
{
    public static void Main()
    {
        Configuration conf = new Configuration();
        conf.BasePath = "http://Your.Server.URL/";
        
        
        // Configure API key authorization: paToken
        conf.ApiKey.Add("paToken", "YOUR_API_KEY");
        // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
        // conf.ApiKeyPrefix.Add("paToken", "Bearer");

        GlobalConfiguration.Instance = conf;
        
        // Create an instance of the API class
        var apiInstance = new NotificationServiceApi();

        try {
            // Returns server metrics.
            // "array[ServerMetrics]" is only psaudo-code to symbolize array of type and not the actual usage 
            array[ServerMetrics] result = apiInstance.readServersMetrics();
            Debug.WriteLine(result);
        } catch (Exception e) {
            Debug.Print("Exception when calling NotificationServiceApi.readServersMetrics: " + e.Message );
        }
    }
}


    import com.pyramidanalytics
from com.pyramidanalytics import ApiException
from com.pyramidanalytics import NotificationServiceApi
from pprint import pprint

        
# Configure API key authorization: paToken
api_config = com.pyramidanalytics.Configuration(host = 'http://Your.Server.URL/', api_key={ paToken:'YOUR_ACCESS_TOKEN' })

with com.pyramidanalytics.ApiClient(api_config) as api_client:
    # Create an instance of the API class
    api_instance = NotificationServiceApi(api_client)

    try:
        # Returns server metrics.
        api_response = api_instance.read_servers_metrics()
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling NotificationServiceApi->readServersMetrics: %s\n" % e)
    <?php
require_once(__DIR__ . '/vendor/autoload.php');

OpenAPITools\Client\Configuration::getDefaultConfiguration()->setHost('http://Your.Server.URL');

// Configure API key authorization: paToken
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('paToken', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('paToken', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\NotificationServiceApi();

try {
    $result = $api_instance->readServersMetrics();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling NotificationServiceApi->readServersMetrics: ', $e->getMessage(), PHP_EOL;
}
?>